/*
 * Copyright (C) 2025 Tsingteng MicroSystem
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * @file nci_module.h
 * @brief NCI模块定义
 */

#ifndef _NCI_MODULE_H_
#define _NCI_MODULE_H_

#include "nci_base.h"
#include "nci_cfg.h"

#define NCI_MODULE_NAME_MAX_LEN 30

/**
 * @brief NCI模块状态
 */
typedef enum {
    /** @brief 关闭状态 */
    NCI_MODULE_STATE_DISABLED = 0,
    /** @brief 打开状态 */
    NCI_MODULE_STATE_ENABLED,
    /** @brief 被移除的状态，此状态下模块不会被初始化 */
    NCI_MODULE_STATE_REMOVED,
    NCI_MODULE_STATE_MAX,
} tNCI_MODULE_STATE;

/** @brief 模块初始化参数结构体 */
typedef struct {
    /** @brief 外部传入的初始化参数 */
    const tNCI_INIT_CFG *p_external_cfg;
    /** @brief CORE INIT RESPONSE */
    tNCI_INIT_RESP init_resp;
} tNCI_MODULE_INIT_CFG;

/**
 * @brief NCI模块结构体
 */
typedef struct {
    /** @brief 模块名称 */
    char name[NCI_MODULE_NAME_MAX_LEN];
    /** @brief 模块当前状态 */
    tNCI_MODULE_STATE state;
    /**
     * @brief 模块初始化函数
     * @param p_cfg 初始化参数结构体指针，可在此结构体中取模块需要的初始化参数
     * @return 成功返回NCI_STATUS_OK, 失败返回对应的错误码
     */
    tNCI_STATUS (*init)(const tNCI_MODULE_INIT_CFG *p_cfg);
    /**
     * @brief 模块反初始化函数
     * @param is_shutdown 是否为关机流程，为true表示关机流程
     * @return 成功返回NCI_STATUS_OK, 失败返回对应的错误码
     */
    tNCI_STATUS (*deinit)(bool is_shutdown);
    /**
     * @brief Dump模块状态到文件描述符fd中
     *
     * @param fd 写入dump数据的文件的文件描述符
     */
    void (*dump)(int fd);
} tNCI_MODULE;

#endif // _NCI_MODULE_H_
